Move the documentation for signals inline, to get proper parameter

Thu Dec 11 01:57:05 2003  Matthias Clasen  <maclas@gmx.de>

	* gdk-pixbuf-loader.c (gdk_pixbuf_loader_class_init): Move
	the documentation for signals inline, to get proper parameter
	documentation.  (#128977)

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index fcc260c1f7b805038da767d236c718d9107f21be..f4ecd53bdd936878a236ace947ed7371b695881a 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+Thu Dec 11 01:57:55 2003  Matthias Clasen  <maclas@gmx.de>
+
+       * gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml: Signal documentation
+       moved inline.
+
 Thu Dec 11 00:04:10 2003  Matthias Clasen  <maclas@gmx.de>
 
        * gtk/gtk-sections.txt: Add gtk_window_[sg]et_accept_focus().

diff --git a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml
index 1845a2573e37462077d5898a5f48a3bde4199766..7fd47cac2ab58b8a31e6208f14846d04b54d6f9c 100644 (file)
--- a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml
@@ -78,65 +78,33 @@ fields.
 
 <!-- ##### SIGNAL GdkPixbufLoader::area-prepared ##### -->
   <para>
-    This signal is emitted when the pixbuf loader has allocated the pixbuf
-    in the desired size.  After this signal is emitted, applications can 
-    call gdk_pixbuf_loader_get_pixbuf() to fetch the partially-loaded pixbuf.
   </para>
 
-@gdkpixbufloader: the object which received the signal.
+@gdkpixbufloader:
 
 <!-- ##### SIGNAL GdkPixbufLoader::area-updated ##### -->
   <para>
-    This signal is emitted when a significant area of the image being
-    loaded has been updated.  Normally it means that a complete
-    scanline has been read in, but it could be a different area as
-    well.  Applications can use this signal to know when to repaint
-    areas of an image that is being loaded.
   </para>
 
-@gdkpixbufloader: Loader which emitted the signal.
+@gdkpixbufloader:
 @arg1: 
 @arg2: 
 @arg3: 
 @arg4: 
-<!-- # Unused Parameters # -->
-@x: X offset of upper-left corner of the updated area.
-@y: Y offset of upper-left corner of the updated area.
-@width: Width of updated area.
-@height: Height of updated area.
 
 <!-- ##### SIGNAL GdkPixbufLoader::closed ##### -->
   <para>
-    This signal is emitted when gdk_pixbuf_loader_close() is called.
-    It can be used by different parts of an application to receive
-    notification when an image loader is closed by the code that
-    drives it.
   </para>
 
-@gdkpixbufloader: the object which received the signal.
-
-<!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
+@gdkpixbufloader: 
 
 <!-- ##### SIGNAL GdkPixbufLoader::size-prepared ##### -->
   <para>
-    This signal is emitted when the pixbuf loader has been fed the
-    initial amount of data that is required to figure out the size
-    of the image that it will create.  Applications can call  
-    gdk_pixbuf_loader_set_size() in response to this signal to set
-    the desired size to which the image should be scaled.
   </para>
 
-@gdkpixbufloader: the object which received the signal.
+@gdkpixbufloader: 
 @arg1: 
 @arg2: 
-<!-- # Unused Parameters # -->
-@width: the original width of the image
-@height: the original height of the image
 
 <!-- ##### FUNCTION gdk_pixbuf_loader_new ##### -->
 <para>
@@ -224,4 +192,11 @@ End:
 @error: 
 @Returns: 
 
+<!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
+
 

diff --git a/gdk-pixbuf/ChangeLog b/gdk-pixbuf/ChangeLog
index e1286f7441ea22d64d126f4fa3c5142b2c909720..f9ff08314ea1499fefe5f86fbd26986d1d60c38a 100644 (file)
--- a/gdk-pixbuf/ChangeLog
+++ b/gdk-pixbuf/ChangeLog
@@ -1,3 +1,9 @@
+Thu Dec 11 01:57:05 2003  Matthias Clasen  <maclas@gmx.de>
+
+       * gdk-pixbuf-loader.c (gdk_pixbuf_loader_class_init): Move
+       the documentation for signals inline, to get proper parameter
+       documentation.  (#128977)
+
 Sat Nov 15 00:26:19 2003  Matthias Clasen  <maclas@gmx.de>
 
        * queryloaders.c (loader_sanity_check): Check that the mask

diff --git a/gdk-pixbuf/gdk-pixbuf-loader.c b/gdk-pixbuf/gdk-pixbuf-loader.c
index 90635ed62a58d8a3814050f9514a86908d2609b4..b4c135252e532410357ff4cf6b7eba3db1abf115 100644 (file)
--- a/gdk-pixbuf/gdk-pixbuf-loader.c
+++ b/gdk-pixbuf/gdk-pixbuf-loader.c
@@ -70,7 +70,6 @@ typedef struct
 
 /**
  * gdk_pixbuf_loader_get_type:
- * @void:
  *
  * Registers the #GdkPixbufLoader class if necessary, and returns the type ID
  * associated to it.
@@ -116,6 +115,18 @@ gdk_pixbuf_loader_class_init (GdkPixbufLoaderClass *class)
   
         object_class->finalize = gdk_pixbuf_loader_finalize;
 
+        /**
+         * GdkPixbufLoader::size-prepared:
+         * @loader: the object which received the signal.
+         * @width: the original width of the image
+         * @height: the original height of the image
+         *
+         * This signal is emitted when the pixbuf loader has been fed the
+         * initial amount of data that is required to figure out the size
+         * of the image that it will create.  Applications can call  
+         * gdk_pixbuf_loader_set_size() in response to this signal to set
+         * the desired size to which the image should be scaled.
+         */
         pixbuf_loader_signals[SIZE_PREPARED] =
                 g_signal_new ("size_prepared",
                               G_TYPE_FROM_CLASS (object_class),
@@ -127,6 +138,15 @@ gdk_pixbuf_loader_class_init (GdkPixbufLoaderClass *class)
                               G_TYPE_INT,
                               G_TYPE_INT);
   
+        /**
+         * GdkPixbufLoader::area-prepared:
+         * @loader: the object which received the signal.
+         *
+         * This signal is emitted when the pixbuf loader has allocated the 
+         * pixbuf in the desired size.  After this signal is emitted, 
+         * applications can call gdk_pixbuf_loader_get_pixbuf() to fetch 
+         * the partially-loaded pixbuf.
+         */
         pixbuf_loader_signals[AREA_PREPARED] =
                 g_signal_new ("area_prepared",
                               G_TYPE_FROM_CLASS (object_class),
@@ -135,7 +155,21 @@ gdk_pixbuf_loader_class_init (GdkPixbufLoaderClass *class)
                               NULL, NULL,
                               gdk_pixbuf_marshal_VOID__VOID,
                               G_TYPE_NONE, 0);
-  
+
+        /**
+         * GdkPixbufLoader::area-updated:
+         * @loader: the object which received the signal.
+         * @x: X offset of upper-left corner of the updated area.
+         * @y: Y offset of upper-left corner of the updated area.
+         * @width: Width of updated area.
+         * @height: Height of updated area.
+         *
+         * This signal is emitted when a significant area of the image being
+         * loaded has been updated.  Normally it means that a complete
+         * scanline has been read in, but it could be a different area as
+         * well.  Applications can use this signal to know when to repaint
+         * areas of an image that is being loaded.
+         */
         pixbuf_loader_signals[AREA_UPDATED] =
                 g_signal_new ("area_updated",
                               G_TYPE_FROM_CLASS (object_class),
@@ -149,6 +183,15 @@ gdk_pixbuf_loader_class_init (GdkPixbufLoaderClass *class)
                               G_TYPE_INT,
                               G_TYPE_INT);
   
+        /**
+         * GdkPixbufLoader::closed:
+         * @loader: the object which received the signal.
+         *
+         * This signal is emitted when gdk_pixbuf_loader_close() is called.
+         * It can be used by different parts of an application to receive
+         * notification when an image loader is closed by the code that
+         * drives it.
+         */
         pixbuf_loader_signals[CLOSED] =
                 g_signal_new ("closed",
                               G_TYPE_FROM_CLASS (object_class),